Skip to main content

Clear All Settings in a Domain (xui.clear)

Declaration​

ok = xui.clear(domain)

Parameters​

  • domain
    String. The defaults domain identifier used by the config UI.

Returns​

  • ok
    Boolean. true on success; false on failure (usually because the specified domain does not exist).

Description​

This function clears all stored settings under the specified domain at once; if the config UI is currently displayed, the displayed values are updated immediately.
After clearing, call xui.setup to regenerate the default settings for the config UI.
See the config UI standard: XUI

Examples​

xui.clear('com.yourcompany.A-Script-Bundle')
xui.setup('interface.xui')